<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
  <head>
    <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
    <title>SnapShotControl v2.0 Reference</title>
    <link rel="stylesheet" type="text/css" href="http://code.google.com/css/codesite.css"></link>
    <link rel="stylesheet" type="text/css" href="../../util/docs/template/local_extensions.css"></link>
  </head>
  <body>
    <h1>SnapShotControl</h1>
    <p>
<p>This library makes it easy to generate an image "snapshot" of your
interactive map, using the Google Static Maps API.</p>
<p>The default behavior adds a control to the map,
and then shows a popup with the snapshot when the control is clicked.
However, the control can be hidden and the generated
snapshot URLs can be programmatically retrieved, so the library may be used
in a more flexible manner.
</p>
<p>This control can detect the standard overlays (Marker, Polygon, Polyline,
Circle, Rectangle and Result of directions) and render them in the snapshot,
and in the case of a poly with many points,
it can pass in the points as an encoded string, resulting in a shorter URL.
Note that this control can't be capable of Layers (FusionLayer, KML layer, so on.)
</p>
<p>Also, the control can reproduce type of map even if it uses Styled Map type. 
Note that  when you use Styled Map type in your interactive map, 
a generated url is apt to be long over the limit of acceptable length of Google Server.
</p>
* <p>Be careful, you want to use this control in case directions and a styled map type,
you have to create a instance of this control before use them.
(cf. <code>"./examples.html"</code>)
</p>
<p>Various options can be sent into the constructor to change the default
rendering of the snapshot.
</p></p>
    <p>For a description and examples of how to use this library, check out the <a href="examples.html">how-to</a>.</p>
    
      <h2><a name="SnapShotControl"></a>class SnapShotControl</h2>
      <p></p>
      
    
      <h2><a name="SnapShotControlOptions"></a>class SnapShotControlOptions</h2>
      <p>This class represents optional arguments to <code><a href="reference.html#_global_#SnapShotControl">SnapShotControl</a></code>.  There is no constructor for this class.  Instead, this class is instantiated as a javascript object literal.</p>
      
        <h3>Properties</h3>
        <table summary="class SnapShotControlOptions - Properties" width="90%">
          
          <tbody>
            <tr>
              <th>Properties</th>
              
                
                  <th>Type</th>
                
              
              <th>Description</th>
            </tr>
            
              <tr class="odd">
                <td><code>adjustCenter</code></td>
                
                  
                    <td><code>Boolean</code></td>
                  
                
                <td>Static Maps API v2 offers implicit
          positioning function. If it is set to true, the control uses that.
          (cf. <a
          href="http://code.google.com/apis/maps/documentation/staticmaps/#ImplicitPositioning">ImplicitPositioning</a>)  The default value is <code> false</code>.</td>
              </tr>
            
              <tr class="even">
                <td><code>adjustZoom</code></td>
                
                  
                    <td><code>Boolean</code></td>
                  
                
                <td>Static Maps API v2 offers implicit
          positioning function. If it is set to true, the control uses that.
          (cf. <a
          href="http://code.google.com/apis/maps/documentation/staticmaps/#ImplicitPositioning">ImplicitPositioning</a>)  The default value is <code> false</code>.</td>
              </tr>
            
              <tr class="odd">
                <td><code>buttonLabelHtml</code></td>
                
                  
                    <td><code>String</code></td>
                  
                
                <td>Specify label HTML of
          control button.  The default value is <code> "Say cheese!"</code>.</td>
              </tr>
            
              <tr class="even">
                <td><code>format</code></td>
                
                  
                    <td><code>String</code></td>
                  
                
                <td>Specify image format for snapshot. You
          can choice one from "gif", "jpg", "jpg-baseline", "png8", "png32".
          ignored, when the <code>style</code> property is not set to "roadmap".  The default value is <code> "png"</code>.</td>
              </tr>
            
              <tr class="odd">
                <td><code>hidden</code></td>
                
                  
                    <td><code>Boolean</code></td>
                  
                
                <td>Specify visibility when control is added
          to the map. If it is set to true, the button is hidden.  The default value is <code> false</code>.</td>
              </tr>
            
              <tr class="even">
                <td><code>language</code></td>
                
                  
                    <td><code>String</code></td>
                  
                
                <td>Specify language for snapshot's
          copyrights. If it is not set, then this library detects the
          language of the map.  The default value is <code> ""</code>.</td>
              </tr>
            
              <tr class="odd">
                <td><code>mapType</code></td>
                
                  
                    <td><code>String</code></td>
                  
                
                <td>Specify maptype for snapshot. The options
          are "roadmap", "satellite", "hybrid", "terrain". If it is not set,
          then the control detects the type of the map.  The default value is <code> ""</code>.</td>
              </tr>
            
              <tr class="even">
                <td><code>popupLabelHtml</code></td>
                
                  
                    <td><code>String</code></td>
                  
                
                <td>Specify label HTML of popup.  The default value is <code> ""</code>.</td>
              </tr>
            
              <tr class="odd">
                <td><code>position</code></td>
                
                  
                    <td><code>LatLng</code></td>
                  
                
                <td>Specify a geological location which is
          passed to static maps. If it is not set, this control will adopt a
          center position of the interactive map. Note that this property is
          only for showPopup method.  The default value is <code> null</code>.</td>
              </tr>
            
              <tr class="even">
                <td><code>usePolylineEncode</code></td>
                
                  
                    <td><code>Boolean</code></td>
                  
                
                <td>Specify whether to use encoded
          polys in the snapshot. Useful if you're sending in a big poly, and
          want to stay within URL limits.  The default value is <code> true</code>.</td>
              </tr>
            
          </tbody>
        </table>
      
    
    <script src="http://www.google-analytics.com/urchin.js" type="text/javascript"></script>
    <script type="text/javascript">
      _uacct = "UA-964209-4";
      urchinTracker();
    </script> 
  </body>
</html>
